package org.truenewx.tnxjee.webmvc.http.annotation;

import org.truenewx.tnxjee.core.Strings;

/**
 * 结果中的枚举过滤配置
 */
public @interface ResultEnumFilter {

    /**
     * @return 枚举属性名
     */
    String name();

    /**
     * 默认情况下，枚举属性序列化会附加caption等属性，而纯粹的枚举类型不会附加属性
     *
     * @return 当前配置的枚举类型是否纯粹
     */
    boolean pure() default false;

    /**
     * 枚举属性的子类型，指定子类型时，附加的caption属性从子类型中取值
     *
     * @return 枚举属性的子类型
     */
    String subType() default Strings.EMPTY;

}
